vcDetachProductStatement

Detach statement detaches the component(s) of one or more products from the component of a common parent product. The products to detach can be filtered by type.

See in: Overview

Module: vcProcessModel

Parent: vcStatement

Children -

Referenced by: -

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

NameTypeAccessDescription
DetachManyBooleanRWGets or sets the detach many value. When True, detaches all products that match the filter, otherwise only the first one.
DetachedProductVariableNameStringRWGets or sets the name of output variable where to store references to the detached products.
FiltervcProductFilterRGets the filter.
ParentProductVariableNameStringRWGets or sets the name of input variable from which to get the parent product instance.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

NameReturn TypeParametersDescription
demoteFromCombinationFiltervcProductFilterNoneDowngrades back to filter, filter count must have 1 or 0 filters.
See more
Returns:
vcProductFilter: The modified filter.

Exceptions:
TypeError: When the filter is not a CombinationFilter.
TypeError: When CombinationFilter has more than 1 sub-filters.
promoteToCombinationFiltervcProductFilterNoneUpgrades current filter to combination filter.
See more
Returns:
vcProductFilter: The modified filter.

Exceptions:
TypeError: When the filter is already a CombinationFilter.
replaceFromvcProductFiltervcStatement statementSets filter from other container.
See more
Parameters:
statement (vcStatement): The statement to replace the filter from. Has to be a statement with a filter container.

Returns:
vcProductFilter: The modified filter.

Exceptions:
AttributeError: When argument is a statement without a filter container.
setFiltervcProductFiltervcProductFilterType filterTypeSets to specific filter.
See more
Parameters:
filterType (vcProductFilterType): The type of filter to set to.

Returns:
vcProductFilter: The new filter.

Exceptions:
AttributeError: When the argument filterType is ProductType.

Events

Learn how to use events here. The events are also inherited from the parent class.

NameParametersDescription
OnFilterChangedNoneTriggered when filter is changed.